<HTML>

<HEAD>
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->

	<META NAME="GENERATOR" Content="CppDoc">
	<TITLE>Nestopia Core API: Nes::Api::Video::Palette</TITLE>

</HEAD>

<BODY>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#eeeeff">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
  <TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Nestopia Core API</B></EM>
</TD>
</TR>

<TR>
<TD><FONT SIZE="-2">
  <a href="../../index.html" target="_top"><B>FRAMES</B></a>  &nbsp;
&nbsp;<a href="../api/Nes..Api..Video..Palette.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
api</FONT>
<BR>
Class  Nes::Api::Video::Palette</H2>
<HR>
<DL>
<DT>class <B><a href="../api/Nes..Api..Video.html">Nes::Api::Video</a>::Palette</B></DT></DL>

<p>Palette interface.
<p>

<HR>


<!-- =========== INNER CLASSES, TYPEDEFS, ENUMS =========== -->

<A NAME="inner_defs_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Inner Classes, Typedefs, and Enums</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>typedef</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..Video..Palette..Colors.html">Nes::Api::Video::Palette::Colors</a></CODE></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;RGB colors.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>enum</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a></CODE></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Custom palette types.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>enum</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a></CODE></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Palette modes</TD>
</TR>
</TABLE>
&nbsp;

<!-- =========== CONSTRUCTOR SUMMARY =========== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#Palette(Core::Machine&)">Palette</a></B>( Core::Machine& instance )</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface constructor</TD>
</TR>
</TABLE>
&nbsp;

<!-- =========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;<a href="../api/Nes..Api..Video..Palette..Colors.html">Nes::Api::Video::Palette::Colors</a></CODE></FONT></TD>
<TD><CODE><B><a href="#GetColors()">GetColors</a></B>() const</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the current palette colors.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;uint</CODE></FONT></TD>
<TD><CODE><B><a href="#GetCustom(uchar(*[3],CustomType)">GetCustom</a></B>( uchar ( * colors )[ 3], <a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a> type ) const</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the custom palette.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;<a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a></CODE></FONT></TD>
<TD><CODE><B><a href="#GetCustomType()">GetCustomType</a></B>() const</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the custom palette type.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;<a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a></CODE></FONT></TD>
<TD><CODE><B><a href="#GetDefaultMode()">GetDefaultMode</a></B>() const</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the default palette mode.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;<a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a></CODE></FONT></TD>
<TD><CODE><B><a href="#GetMode()">GetMode</a></B>() const</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current palette mode.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><a href="#ResetCustom()">ResetCustom</a></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets the custom palette.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;Result</CODE></FONT></TD>
<TD><CODE><B><a href="#SetCustom(Colors,CustomType)">SetCustom</a></B>( <a href="../api/Nes..Api..Video..Palette..Colors.html">Nes::Api::Video::Palette::Colors</a> colors, <a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a> type = STD_PALETTE )</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the custom palette.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;Result</CODE></FONT></TD>
<TD><CODE><B><a href="#SetMode(Mode)">SetMode</a></B>( <a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a> mode )</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the palette mode.</TD>
</TR>
</TABLE>
&nbsp;

<BR>
<BR>
<!-- ============ Constructor Detail ========== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="Palette(Core::Machine&)"><!-- --></A>
<A NAME="Palette"><!-- --></A>
<H3>Palette</H3>
<PRE>
public <B>Palette</B>( Core::Machine& instance );
</PRE>
<DL>
<DD>Interface constructor
</DD>
<DL>
<DT><B>Parameters: </B><DD><code>instance</code> - emulator instance</DD>
</DL>

</DL>
<HR>

<BR>
<!-- ============ Method Detail ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="GetColors()"><!-- --></A>
<A NAME="GetColors"><!-- --></A>
<H3>GetColors</H3>
<PRE>
public <a href="../api/Nes..Api..Video..Palette..Colors.html">Nes::Api::Video::Palette::Colors</a> <B>GetColors</B>() const throw();
</PRE>
<DL>
<DD>Return the current palette colors.
</DD>
<DL>
<DT><B>Returns: </B><DD>palette colors</DD>
</DL>

</DL>
<HR>

<A NAME="GetCustom(uchar(*[3],CustomType)"><!-- --></A>
<A NAME="GetCustom"><!-- --></A>
<H3>GetCustom</H3>
<PRE>
public uint <B>GetCustom</B>( uchar ( * colors )[ 3], <a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a> type ) const throw();
</PRE>
<DL>
<DD>Returns the custom palette.
</DD>
<DL>
<DT><B>Parameters: </B><DD><code>colors</code> - RGB colors to be filled
<DD><code>type</code> - custom palette type</DD>
<DT><B>Returns: </B><DD>number of colors written</DD>
</DL>

</DL>
<HR>

<A NAME="GetCustomType()"><!-- --></A>
<A NAME="GetCustomType"><!-- --></A>
<H3>GetCustomType</H3>
<PRE>
public <a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a> <B>GetCustomType</B>() const throw();
</PRE>
<DL>
<DD>Returns the custom palette type.
</DD>
<DL>
<DT><B>Returns: </B><DD>custom palette type</DD>
</DL>

</DL>
<HR>

<A NAME="GetDefaultMode()"><!-- --></A>
<A NAME="GetDefaultMode"><!-- --></A>
<H3>GetDefaultMode</H3>
<PRE>
public <a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a> <B>GetDefaultMode</B>() const throw();
</PRE>
<DL>
<DD>Returns the default palette mode.
</DD>
<DL>
<DT><B>Returns: </B><DD>default palette mode</DD>
</DL>

</DL>
<HR>

<A NAME="GetMode()"><!-- --></A>
<A NAME="GetMode"><!-- --></A>
<H3>GetMode</H3>
<PRE>
public <a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a> <B>GetMode</B>() const throw();
</PRE>
<DL>
<DD>Returns the current palette mode.
</DD>
<DL>
<DT><B>Returns: </B><DD>current mode</DD>
</DL>

</DL>
<HR>

<A NAME="ResetCustom()"><!-- --></A>
<A NAME="ResetCustom"><!-- --></A>
<H3>ResetCustom</H3>
<PRE>
public void <B>ResetCustom</B>() throw();
</PRE>
<DL>
<DD>Resets the custom palette.
</DD>

</DL>
<HR>

<A NAME="SetCustom(Colors,CustomType)"><!-- --></A>
<A NAME="SetCustom"><!-- --></A>
<H3>SetCustom</H3>
<PRE>
public Result <B>SetCustom</B>( <a href="../api/Nes..Api..Video..Palette..Colors.html">Nes::Api::Video::Palette::Colors</a> colors, <a href="../api/Nes..Api..Video..Palette..CustomType.html">Nes::Api::Video::Palette::CustomType</a> type = STD_PALETTE ) throw();
</PRE>
<DL>
<DD>Sets the custom palette.
</DD>
<DL>
<DT><B>Parameters: </B><DD><code>colors</code> - RGB color data
<DD><code>type</code> - custom palette type</DD>
</DL>

</DL>
<HR>

<A NAME="SetMode(Mode)"><!-- --></A>
<A NAME="SetMode"><!-- --></A>
<H3>SetMode</H3>
<PRE>
public Result <B>SetMode</B>( <a href="../api/Nes..Api..Video..Palette..Mode.html">Nes::Api::Video::Palette::Mode</a> mode ) throw();
</PRE>
<DL>
<DD>Sets the palette mode.
</DD>
<DL>
<DT><B>Parameters: </B><DD><code>mode</code> - palette mode</DD>
<DT><B>Returns: </B><DD>result code</DD>
</DL>

</DL>
<HR>

<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#eeeeff">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
  <TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
  <TD BGCOLOR="#eeeeff">    &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Nestopia Core API</B></EM>
</TD>
</TR>

<TR>
<TD><FONT SIZE="-2">
  <a href="../../index.html" target="_top"><B>FRAMES</B></a>  &nbsp;
&nbsp;<a href="../api/Nes..Api..Video..Palette.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>


</BODY>

</HTML>

